ReqAddInfo

This operation enables the relevant organisation to request that the applicant uploads additional information to the ePlanning from their IT system.

path Parameters
CaseID
required
string

A fully qualified application number

header Parameters
OrganisationID
required
string

The relevant organisation name to indicate where the request is originated from.

IdempotencyID
required
string

Unique Id for this request. Allows the API to respond in an idempotent way if it has already been called with these parameters and prevents duplicate processing. Typically a UUID such as "63a9ba30-7a4b-4fac-b343-d1f05cf089f1"

Request Body schema: application/json
requestDetails
required
string

This is to track the short description of the request

Array of objects (DownloadableDocument)
updatedByEmail
required
string <= 250 characters

User must be registered in the planning portal

Responses

Request samples

Content type
application/json
{
  • "requestDetails": "string",
  • "Documents": [
    ],
  • "updatedByEmail": "john.smith@gmail.com"
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "message": "Request created",
  • "caseID": "AI-XXXX",
  • "activityId": "string",
  • "Documents": [
    ]
}
Next to CloseAICase